chore: update style guidelines#2158
Conversation
fselmo
left a comment
fselmo
left a comment
There was a problem hiding this comment.
lgtm, minor spelling correction but approving to unblock once that's in
| # EIP-1234: The dingus is the rate of fleep | ||
| dingus = a + b | ||
|
|
||
| # EIP-4567: Frobulate the dingus |
danceratopz
left a comment
danceratopz
left a comment
There was a problem hiding this comment.
Looks good @SamWilsn! Just one question below regarding docstrings.
| The marked lines (`<-`) are now incorrectly attributed to EIP-4567 in Fork+1. Instead, omit the EIP identifier in the comments, and describe the changes introduced by the EIP in the function's docstrings. The rendered diffs will make it pretty obvious what's changed. | ||
| </details> | ||
|
|
||
| #### Docstrings |
There was a problem hiding this comment.
Sam, was a standard ever set for EELS docstrings to be either declarative (numpy) or imperative (PEP 257). I spotted that we currently use both, perhaps we can try to stick to one going forward?
For example:
- Imperative:
- Indicative:
There was a problem hiding this comment.
That's a good question. I have no idea.
Personally, my top priority is eventually getting to something like the CL annotated spec. I'm not sure the various projects attempting to do that agree on much though.
There was a problem hiding this comment.
Follow-up here:
Co-authored-by: felipe <fselmo2@gmail.com>
3 participants
Cute Animal Picture